Accelerator MariaDB Global Party System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| GlobalPartyTools | Common functions and variables used for Global Party |
| contactpointsaddress-storedprocedure-request | ContactPointAddress Create/Update Mapping for Global Data System |
| contactpointsemail-storedprocedure-request | ContactPointEmail Create/Update Mapping for Global Data System |
| contactpointsphone-storedprocedure-request | ContactPointPhone Create/Update Mapping for Global Data System |
| contactpoints-get-response | ContactPoint Retrieve Mapping for Global Data System |
| get-contactpoints-externalids-response | ExternalIds Query Mapping for Global Data System |
| customers-post-payload | Customer Create Mapping for Global Data System |
| customers-patch-payload | Customer Update Mapping for Global Data System. Checks are done to see if the value exists in DB, and only updated is the incoming request has a not null value. Some of the fields cannot be updated and they are ignored. |
| customers-get-response | Customer Retrieve Mapping for Global Data System |
| customers-search-response | Customer Search Mapping for Global Data System |
| post-externalids-payload | ExternalIds Upsert Mapping for Global Data System |
| get-externalids-response | ExternalIds Query Mapping for Global Data System |
| partyroles-get-response | PartyRoles Retrieve Mapping for Global Data System |
| get-related-parties-response | RelatedParties Retrieve Mapping for Global Data System |
| put-related-parties-payload | RelatedParties Upsert Mapping for Global Data System |
| parties-get-response | Parties Query Mapping for Global Data System |
| parties-related-parties-externalids | ExternalIds Query Mapping for Global Data System |
| individuals-post-payload | Create Individual Mapping for Global Data System. Maps CIM Individual to JSON which is used by stored procedure sp_Individuals_Create. The fields in both CIM and JSON are identical. |
| individuals-patch-payload | Update Individual Mapping for Global Data System. Maps CIM Indiviudal to payload which is used as input parameter in the update query of INDIVIDUAL table. The fields in both CIM and Global Data are identical. PATCH payload is created by validating the Input Request payload with DB Record Payload. Few of the DB fields will not be updated as they are not allowed. |
| individuals-get-response | Search and Retrieve of Individual Mappings for Global Data System |
| organizations-post-payload | Create organization Mapping for Global Data System. Maps CIM organization to JSON which is used by stored procedure sp_Organizations_Create. The fields in both CIM and JSON are identical. |
| organizations-patch-payload | Create Organization Mapping for Global Data System Maps CIM Organization to payload which is used as input parameter in the update query of ORGANIZATION table. The fields in both CIM and Global Data System are identical. PATCH payload is created by validating the Input Request payload with DB Record Payload. |
| organizations-get-response | Retrieve Organization Mapping for Global Data System |
| households-post-payload | Create Household Mapping for Global Data System. Maps CIM Household to payload which is used as input parameter to insert into Household table. The fields in both CIM and Global Data are identical. |
| households-patch-payload | Mapping for Global Data System to Update Household. Maps CIM Household to payload which is used as input parameter in the update Household table. The fields in both CIM and Global Data are identical. PATCH payload is created by validating the Input Request payload with DB Record Payload. |
| households-get-response | Retrieve and Search Household Mapping for Global Data System |
GlobalPartyTools
Common functions and variables used for Global Party
Source:
./src/main/resources/dwl/GlobalPartyTools.dwl
Functions
fun convertBoolean (item)
Function to convert boolean values to 0 or 1
param
item- Takes input to convert fields that holds boolean values as true or false
return - JSON object with values converted for boolean fields as 1 or 0
contactpointsaddress-storedprocedure-request
ContactPointAddress Create/Update Mapping for Global Data System
Source:
./src/main/resources/dwl/contactpointsaddress-storedprocedure-request.dwl
contactpointsemail-storedprocedure-request
ContactPointEmail Create/Update Mapping for Global Data System
Source:
./src/main/resources/dwl/contactpointsemail-storedprocedure-request.dwl
Mapping Tables
Maps CIM ContactPointEmail to JSON which is used by stored procedure - sp_ContactPointEmail_Create or sp_ContactPointEmail_Update
| JSON used by the stored procedure | CIM | Default Value | Description |
|---|---|---|---|
| id | id | The id of the contactpoint | |
| contactPointType | contactPointType | The type of contact point | |
| activeFromDate | activeFromDate | now() | The date from which contactpoint is active |
| activeToDate | activeToDate | The date until which contactpoint is active | |
| bestTimeToContactEndTime | bestTimeToContactEndTime | The best time to contact end time | |
| bestTimeToContactStartTime | bestTimeToContactStartTime | The best time to contact start time | |
| createdBy | auditInfo.createdBy | p('app.name') | Identifies the system or user which created the entity |
| createdDate | auditInfo.createdDate | now() | Timestamp of when the entity was created |
| emailAddress | emailAddress | "" | The email address of the contactpoint |
| emailBouncedReason | emailBouncedReason | The reason indicating why the email bounces | |
| emailDomain | emailDomain | The domain of the email address | |
| emailLatestBounceDateTime | emailLatestBounceDateTime | Timestamp of when the email last bounced | |
| emailMailBox | emailMailBox | The email mail box to which email must be delivered | |
| forBusinessUse | forBusinessUse | Flag to indicate whether this contactpoint is used for business purpose | |
| forPersonalUse | forPersonalUse | Flag to indicate whether this contactpoint is used for personal use | |
| isUsedForBilling | isUsedForBilling | Flag to indicate whether the email address is used for billing | |
| isUsedForShipping | isUsedForShipping | Flag to indicate whether the email address is used for shipping | |
| name | name | The name of the contactpoint email address | |
| primaryFlag | primaryFlag | Flag to indicate if the email address is primary | |
| profileFirstCreatedDate | profileFirstCreatedDate | Timestamp of when the profile was first created | |
| profileLastUpdatedDate | profileLastUpdatedDate | Timestamp of when the profile was last updated | |
| profileOccurrenceCount | profileOccurrenceCount | The occurrence of profile | |
| updatedBy | auditInfo.updatedBy | p('app.name') | Identifies the system or user which last updated the entity |
| updatedDate | auditInfo.updatedDate | now() | Timestamp of when the entity was last updated |
contactpointsphone-storedprocedure-request
ContactPointPhone Create/Update Mapping for Global Data System
Source:
./src/main/resources/dwl/contactpointsphone-storedprocedure-request.dwl
Mapping Tables
Maps CIM ContactPointPhone to JSON which is used by stored procedure - sp_ContactPointPhone_Create or sp_ContactPointPhone_Uopdate
| JSON used by the stored procedure | CIM | Default Value | Description |
|---|---|---|---|
| id | id | The id of the contactpoint | |
| contactPointType | contactPointType | The type of contact point | |
| activeFromDate | activeFromDate | now() | The date from which contactpoint is active |
| activeToDate | activeToDate | The date until which contactpoint is active | |
| areaCode | areaCode | The area code of the contactpoint | |
| bestTimeToContactEndTime | bestTimeToContactEndTime | The best time to contact end time | |
| bestTimeToContactStartTime | bestTimeToContactStartTime | The best time to contact start time | |
| countryName | countryName | The country name of the contact point phone | |
| createdBy | auditInfo.createdBy | p('app.name') | Identifies the system or user which created the entity |
| createdDate | auditInfo.createdDate | now() | Timestamp of when the entity was created |
| extensionNumber | extensionNumber | The extension number of the contactpoint phone | |
| formattedE164PhoneNumber | formattedE164PhoneNumber | The formatted E164 phone number | |
| formattedInternationalPhoneNumber | formattedInternationalPhoneNumber | The formatted international phone number | |
| formattedNationalPhoneNumber | formattedNationalPhoneNumber | "000-000-0000" | The formatted national phone number |
| forBusinessUse | forBusinessUse | Flag to inidicate whether this contactpoint is used for business purpose | |
| forPersonalUse | forPersonalUse | Flag to inidicate whether this contactpoint is used for personal use | |
| isFaxCapable | isFaxCapable | Flag to indicate whether the contactpoint phone is fax capable | |
| isSMSCapable | isSMSCapable | Flag to indicate whether the contactpoint phone is sms capable | |
| name | name | The name of the contactpoint phone | |
| phoneCountryCode | phoneCountryCode | The country code of the contactpoint phone | |
| primaryFlag | primaryFlag | Flag to indicate if the phone is primary | |
| primaryPhoneType | primaryPhoneType | The type of primary phone | |
| profileFirstCreatedDate | profileFirstCreatedDate | Timestamp of when the profile was first created | |
| profileLastUpdatedDate | profileLastUpdatedDate | Timestamp of when the profile was last updated | |
| profileOccurrenceCount | profileOccurrenceCount | The occurence of profile | |
| shortCode | shortCode | The short code of the contactpoint | |
| telephoneNumber | telephoneNumber | "000-000-0000" | Telephone number of the contactpoint |
| updatedBy | auditInfo.updatedBy | p('app.name') | Identifies the system or user which last updated the entity |
| updatedDate | auditInfo.updatedDate | now() | Timestamp of when the entity was last updated |
contactpoints-get-response
ContactPoint Retrieve Mapping for Global Data System
Source:
./src/main/resources/dwl/contactpoints-get-response.dwl
Mapping Tables
Maps Global Data ContactPoint to CIM ContactPoint format
| CIM | Global Data | Default Value | Description | |
|---|---|---|---|---|
| For each caitem in CONTACT_POINT_ADDRESS | ||||
| id | caitem.ID | The id of the contactpoint | ||
| activeFromDate | caitem.ACTIVE_FROM_DATE | The date from which contactpoint is active | ||
| activeToDate | caitem.ACTIVE_TO_DATE | The date until which contactpoint is active | ||
| addressLine1 | caitem.ADDRESS_LINE1 | The address line1 of the contactpoint address | ||
| addressLine2 | caitem.ADDRESS_LINE2 | The address line2 of the contactpoint address | ||
| addressLine3 | caitem.ADDRESS_LINE3 | The address line3 of the contactpoint address | ||
| addressLine4 | caitem.ADDRESS_LINE4 | The address line4 of the contactpoint address | ||
| bestTimeToContactEndTime | caitem.BEST_TIME_TO_CONTACT_END_TIME | The best time to contact end time | ||
| bestTimeToContactStartTime | caitem.BEST_TIME_TO_CONTACT_START_TIME | The best time to contact start time | ||
| cityName | caitem.CITY_NAME | The city name of the contactpoint address | ||
| countryName | caitem.COUNTRY_NAME | The country name of the contactpoint address | ||
| contactPointType | "ContactPointAddress" | The type of contactpoint type | ||
| forBusinessUse | caitem.FOR_BUSINESS_USE | Flag to indicate whether this contactpoint is used for business purpose | ||
| forPersonalUse | caitem.FOR_PERSONAL_USE | Flag to indicate whether this contactpoint is used for personal use | ||
| geoAccuracy | caitem.GEO_ACCURACY | The geo accuracy of the contactpoint address | ||
| geoLatitude | caitem.GEO_LATITUDE | The geo latitude of the contactpoint address | ||
| geoLongitude | caitem.GEO_LONGITUDE | The geo longitude of the contactpoint address | ||
| isUsedForBilling | caitem.IS_USED_FOR_BILLING | Flag to indicate whether the address is used for billing | ||
| isUsedForShipping | caitem.IS_USED_FOR_SHIPPING | Flag to indicate whether the address is used for billing | ||
| name | caitem.CONTACT_POINT_ADDRESS_NAME | The name of the contactpoint address | ||
| postalCodeText | caitem.POSTAL_CODE_TEXT | The postalcode of the contactpoint address | ||
| primaryFlag | caitem.PRIMARY_FLAG | Flag to indicate if the address is primary | ||
| profileFirstCreatedDate | caitem.PROFILE_FIRST_CREATED_DAT | Timestamp of when the profile was first created | ||
| profileLastUpdatedDate | caitem.PROFILE_LAST_UPDATED_DATE | Timestamp of when the profile was last updated | ||
| profileOccurrenceCount | caitem.PROFILE_OCCURRENCE_COUNT | The occurence of profile | ||
| stateProvinceName | caitem.STATE_PROVINCE_NAME | The state province of the contactpoint address | ||
| auditInfo.createdBy | caitem.CREATED_BY | Identifies the system or user which created the entity | ||
| auditInfo.createdDate | caitem.CREATED_DATE | Timestamp of when the entity was created | ||
| auditInfo.updatedBy | caitem.UPDATED_BY | Identifies the system or user which last updated the entity | ||
| auditInfo.updatedDate | caitem.UPDATED_DATE | Timestamp of when the entity was last updated | ||
| auditInfo.isDeleted | caitem.isDeleted | false | Indicates whether or not the entity has been soft-deleted | |
| END of foreach loop | ||||
| For each cpitem in CONTACT_POINT_PHONE | ||||
| id | cpitem.ID | The id of the contactpoint | ||
| activeFromDate | cpitem.ACTIVE_FROM_DATE | The date from which contactpoint is active | ||
| activeToDate | cpitem.ACTIVE_TO_DATE | The date until which contactpoint is active | ||
| areaCode | cpitem.AREA_CODE | The area code of the contactpoint | ||
| bestTimeToContactEndTime | cpitem.BEST_TIME_TO_CONTACT_END_TIME | The best time to contact end time | ||
| bestTimeToContactStartTime | cpitem.BEST_TIME_TO_CONTACT_START_TIME | The best time to contact start time | ||
| countryName | cpitem.COUNTRY_NAME | The country name of the contact point phone | ||
| contactPointType | "ContactPointPhone" | The type of contact point | ||
| extensionNumber | cpitem.EXTENSION_NUMBER | The extension number of the contactpoint phone | ||
| forBusinessUse | cpitem.FOR_BUSINESS_USE | Flag to inidicate whether this contactpoint is used for business purpose | ||
| formattedE164PhoneNumber | cpitem.FORMATTED_E164_PHONE_NUMBER | The formatted E164 phone number | ||
| formattedInternationalPhoneNumber | cpitem.FORMATTED_INTERNATIONAL_PHONE_NUMBER | The formatted international phone number | ||
| formattedNationalPhoneNumber | cpitem.FORMATTED_NATIONAL_PHONE_NUMBER | The formatted national phone number | ||
| forPersonalUse | cpitem.FOR_PERSONAL_USE | Flag to inidicate whether this contactpoint is used for personal use | ||
| isFaxCapable | cpitem.IS_FAX_CAPABLE | Flag to indicate whether the contactpoint phone is fax capable | ||
| isSMSCapable | cpitem.IS_SMS_CAPABLE | Flag to indicate whether the contactpoint phone is sms capable | ||
| name | cpitem.CONTACT_POINT_PHONE_NAME | The name of the contactpoint phone | ||
| phoneCountryCode | cpitem.PHONE_COUNTRY_CODE | The country code of the contactpoint phone | ||
| primaryFlag | cpitem.PRIMARY_FLAG | Flag to indicate if the phone is primary | ||
| primaryPhoneType | cpitem.PRIMARY_PHONE_TYPE | The type of primary phone | ||
| profileFirstCreatedDate | cpitem.PROFILE_FIRST_CREATED_DATE | Timestamp of when the profile was first created | ||
| profileLastUpdatedDate | cpitem.PROFILE_LAST_UPDATED_DATE | Timestamp of when the profile was last updated | ||
| profileOccurrenceCount | cpitem.PROFILE_OCCURRENCE_COUNT | The occurence of profile | ||
| shortCode | cpitem.SHORT_CODE | The short code of the contactpoint | ||
| telephoneNumber | cpitem.TELEPHONE_NUMBER | Telephone number of the contactpoint | ||
| auditInfo.createdBy | cpitem.CREATED_BY | Identifies the system or user which created the entity | ||
| auditInfo.createdDate | cpitem.CREATED_DATE | Timestamp of when the entity was created | ||
| auditInfo.updatedBy | cpitem.UPDATED_BY | Identifies the system or user which last updated the entity | ||
| auditInfo.updatedDate | cpitem.UPDATED_DATE | Timestamp of when the entity was last updated | ||
| auditInfo.isDeleted | cpitem.isDeleted | false | Indicates whether or not the entity has been soft-deleted | |
| end of for each loop | ||||
| For each ceitem in CONTACT_POINT_EMAIL | ||||
| id | ceitem.ID | The id of the contactpoint | ||
| activeFromDate | ceitem.ACTIVE_FROM_DATE | The date from which contactpoint is active | ||
| activeToDate | ceitem.ACTIVE_TO_DATE | The date until which contactpoint is active | ||
| bestTimeToContactEndTime | ceitem.BEST_TIME_TO_CONTACT_END_TIME | The best time to contact end time | ||
| bestTimeToContactStartTime | ceitem.BEST_TIME_TO_CONTACT_START_TIME | The best time to contact start time | ||
| contactPointType | "ContactPointEmail" | The type of contact point | ||
| emailAddress | ceitem.EMAIL_ADDRESS | The email address of the contactpoint | ||
| emailBouncedReason | ceitem.EMAIL_LATEST_BOUNCE_REASON_TEXT | The reason indicating why the email bounces | ||
| emailDomain | ceitem.EMAIL_DOMAIN | The domain of the email address | ||
| emailLatestBounceDateTime | ceitem.EMAIL_LATEST_BOUNCE_DATE_TIME | Timestamp of when the email last bounced | ||
| emailMailBox | ceitem.EMAIL_MAIL_BOX | The email mail box to which email must be delivered | ||
| forBusinessUse | ceitem.FOR_BUSINESS_USE | Flag to indicate whether this contactpoint is used for business purpose | ||
| forPersonalUse | ceitem.FOR_PERSONAL_USE | Flag to indicate whether this contactpoint is used for personal use | ||
| name | ceitem.CONTACT_POINT_EMAILADDRESS_NAME | The name of the contactpoint email address | ||
| primaryFlag | ceitem.PRIMARY_FLAG | Flag to indicate if the email address is primary | ||
| profileFirstCreatedDate | ceitem.PROFILE_FIRST_CREATED_DATE | Timestamp of when the profile was first created | ||
| profileLastUpdatedDate | ceitem.PROFILE_LAST_UPDATED_DATE | Timestamp of when the profile was last updated | ||
| profileOccurrenceCount | ceitem.PROFILE_OCCURRENCE_COUNT | The occurence of profile | ||
| auditInfo.createdBy | ceitem.CREATED_BY | Identifies the system or user which created the entity | ||
| auditInfo.createdDate | ceitem.CREATED_DATE | Timestamp of when the entity was created | ||
| auditInfo.updatedBy | ceitem.UPDATED_BY | Identifies the system or user which last updated the entity | ||
| auditInfo.updatedDate | ceitem.UPDATED_DATE | Timestamp of when the entity was last updated | ||
| auditInfo.isDeleted | ceitem.IS_DELETED | false | Indicates whether or not the entity has been soft-deleted | |
| END of foreach loop |
get-contactpoints-externalids-response
ExternalIds Query Mapping for Global Data System
Source:
./src/main/resources/dwl/get-contactpoints-externalids-response.dwl
Variables
var outputPayload
outputPayload variable is the maps the result of select query on Global Data EXTERNAL_ID table.
customers-post-payload
Customer Create Mapping for Global Data System
Source:
./src/main/resources/dwl/customers-post-payload.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by stored procedure - sp_Customers_Create
| JSON used by the stored procedure | CIM | Description | |
|---|---|---|---|
| churnScore | churnScore | The churn score of the customer | |
| customerNumber | customerNumber | The Customer Number to be stored in Global Data System | |
| customerSatisfactionScore | customerSatisfactionScore | The customer satisfaction score | |
| customerStatus | customerStatus | The status of the customer | |
| id | id | The id of the customer | |
| last12MonthsNewRevenueAmount | last12MonthsNewRevenueAmount | The last 12 months new revenue amount of the customer | |
| last12MonthsSupportCallCount | last12MonthsSupportCallCount | The last 12 months support call count made by the customer | |
| last24MonthsNewRevenueAmount | last24MonthsNewRevenueAmount | The last 24 months new revenue amount of the customer | |
| marketingEmailResponseRate | marketingEmailResponseRate | Marketing email response rate of the customer | |
| netPromoterScore | netPromoterScore | The net promoter score of the customer | |
| originatingCustomerSource | originatingCustomerSource | The originating source of the customer | |
| prospectRating | prospectRating | The prospect rating of the customer | |
| totalBookingsAmount | totalBookingsAmount | The total bookings amount made by the customer | |
| totalContractedAmount | totalContractedAmount | The total contracted amount | |
| totalLifeTimeValue | totalLifeTimeValue | The total lifetime value of the customer | |
| totalProfitContributionAmount | totalProfitContributionAmount | The total profit contribution amount by the customer | |
| partyId | party[0] | The id of the individual as party | |
| partyRoleType | partyRoleType | "Customer" | The type of party role - default as Customer |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp | |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp | |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name | |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
customers-patch-payload
Customer Update Mapping for Global Data System. Checks are done to see if the value
exists in DB, and only updated is the incoming request has a not null value.
Some of the fields cannot be updated and they are ignored.
Source:
./src/main/resources/dwl/customers-patch-payload.dwl
Variables
var payloadRecordfromDB
payloadRecordfromDB is the existing customer record in Global Data System
Mapping Tables
Maps CIM Customer to Global Data Customer JSON used to update Global Data System PATCH payload is created by validating the Input Request payload with DB Record Payload.
| Global Data | CIM | Description |
|---|---|---|
| id | vars.customerId | The id of the customer in Global Data System |
| churnScore | if(CHURN_SCORE?) CHURN_SCORE else payloadRecordfromDB.churnScore | The churn score of the customer |
| createdBy | p('app.name') | Identifies the system or user which created the entity - default as property app.name |
| createdDate | now() | Timestamp of when the entity was created - default as current timestamp |
| customerNumber | if(CUSTOMER_NUMBER?) CUSTOMER_NUMBER else payloadRecordfromDB.customerNumber | The Customer Number to be stored in Global Data System |
| customerSatisfactionScore | if(CUSTOMER_SATISFACTION_SCORE?) CUSTOMER_SATISFACTION_SCORE else payloadRecordfromDB.customerSatisfactionScore | The customer satisfaction score |
| customerStatus | if(CUSTOMER_STATUS?) CUSTOMER_STATUS else payloadRecordfromDB.customerStatus | The status of the customer |
| last12MonthsNewRevenueAmount | if(LAST12_MONTHS_NEW_REVENUE_AMOUNT?) LAST12_MONTHS_NEW_REVENUE_AMOUNT else payloadRecordfromDB.last12MonthsNewRevenueAmount | The last 12 months new revenue amount of the customer |
| last12MonthsSupportCallCount | if(LAST12_MONTHS_SUPPORT_CALL_COUNT?) LAST12_MONTHS_SUPPORT_CALL_COUNT else payloadRecordfromDB.last12MonthsSupportCallCount | The last 12 months support call count made by the customer |
| last24MonthsNewRevenueAmount: if(LAST24_MONTHS_NEW_REVENUE_AMOUNT?) LAST24_MONTHS_NEW_REVENUE_AMOUNT else payloadRecordfromDB.last24MonthsNewRevenueAmount | The last 24 months new revenue amount of the customer | |
| marketingEmailResponseRate | if(MARKETING_EMAIL_RESPONSE_RATE?) MARKETING_EMAIL_RESPONSE_RATE else payloadRecordfromDB.marketingEmailResponseRate | Marketing email response rate of the customer |
| netPromoterScore | if(NET_PROMOTER_SCORE?) NET_PROMOTER_SCORE else payloadRecordfromDB.netPromoterScore | The net promoter score of the customer |
| originatingCustomerSource | if(ORIGINATING_CUSTOMER_SOURCE?) ORIGINATING_CUSTOMER_SOURCE else payloadRecordfromDB.originatingCustomerSource | The originating source of the customer |
| prospectRating | if(PROSPECT_RATING?) PROSPECT_RATING else payloadRecordfromDB.prospectRating | The prospect rating of the customer |
| totalBookingsAmount | if(TOTAL_BOOKINGS_AMOUNT?) TOTAL_BOOKINGS_AMOUNT else payloadRecordfromDB.totalBookingsAmount | The total bookings amount made by the customer |
| totalContractedAmount | if(TOTAL_CONTRACTED_AMOUNT?) TOTAL_CONTRACTED_AMOUNT else payloadRecordfromDB.totalContractedAmount | The total contracted amount |
| totalLifeTimeValue | if(TOTAL_LIFE_TIME_VALUE?) TOTAL_LIFE_TIME_VALUE else payloadRecordfromDB.totalLifeTimeValue | The total lifetime value of the customer |
| totalProfitContributionAmount | if(TOTAL_PROFIT_CONTRIBUTION_AMOUNT?) TOTAL_PROFIT_CONTRIBUTION_AMOUNT else payloadRecordfromDB.totalProfitContributionAmount | The total profit contribution amount by the customer |
| updatedBy | p('app.name') | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | now() | Timestamp of when the entity was last updated - default as current timestamp |
| partyId | if(party?) party[0] else payloadRecordfromDB.party[0] | The id of the individual as party |
| partyRoleType | if(PARTY_ROLE_TYPE?) PARTY_ROLE_TYPE else payloadRecordfromDB.partyRoleTypeThe type of party role - default as Customer |
customers-get-response
Customer Retrieve Mapping for Global Data System
Source:
./src/main/resources/dwl/customers-get-response.dwl
Mapping Tables
Maps Global Data Customer to CIM Customer format
| CIM | Global Data | Description |
|---|---|---|
| id | ID | The id of the customer in Global Data System |
| churnScore | CHURN_SCORE | The churn score of the customer |
| customerNumber | CUSTOMER_NUMBER | The Customer Number in Global Data System |
| customerSatisfactionScore | CUSTOMER_SATISFACTION_SCORE | The customer satisfaction score |
| customerStatus | CUSTOMER_STATUS | The status of the customer in Global Data System |
| last12MonthsNewRevenueAmount | LAST12_MONTHS_NEW_REVENUE_AMOUNT | The last 12 months new revenue amount of the customer |
| last12MonthsSupportCallCount | LAST12_MONTHS_SUPPORT_CALL_COUNT | The last 12 months support call count made by the customer |
| last24MonthsNewRevenueAmount | LAST24_MONTHS_NEW_REVENUE_AMOUNT | The last 24 months new revenue amount of the customer |
| marketingEmailResponseRate | MARKETING_EMAIL_RESPONSE_RATE | Marketing email response rate of the customer |
| netPromoterScore | NET_PROMOTER_SCORE | The net promoter score of the customer |
| originatingCustomerSource | ORIGINATING_CUSTOMER_SOURCE | The originating source of the customer |
| party | [ if(vars.individualRecord != null) (vars.individualRecord) else PARTY_ID ] | The id of the individual as party |
| partyRoleType | PARTY_ROLE_TYPE | The type of party role - default as Customer |
| prospectRating | PROSPECT_RATING | The prospect rating of the customer |
| totalBookingsAmount | TOTAL_BOOKINGS_AMOUNT | The total bookings amount made by the customer |
| totalContractedAmount | TOTAL_CONTRACTED_AMOUNT | The total contracted amount |
| totalLifeTimeValue | TOTAL_LIFE_TIME_VALUE | The total lifetime value of the customer |
| totalProfitContributionAmount | TOTAL_PROFIT_CONTRIBUTION_AMOUNT | The total profit contribution amount by the customer |
| externalIds | vars.customerExternalIds | The externalIds of the customer that are stored in Global Data System |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the customer |
| auditInfo.createdDate | CREATED_DATETimestamp of when the customer was created - default as current timestamp | |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the customer |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | isDeleted | Indicates whether or not the customer has been soft-deleted - default as false |
customers-search-response
Customer Search Mapping for Global Data System
Source:
./src/main/resources/dwl/customers-search-response.dwl
Mapping Tables
Maps Global Data Customer to CIM Customer format
| CIM | Global Data | Description | |
|---|---|---|---|
| id | ID | The id of the customer in Global Data System | |
| churnScore | CHURN_SCORE | The churn score of the customer | |
| customerNumber | CUSTOMER_NUMBER | The Customer Number in Global Data System | |
| customerSatisfactionScore | CUSTOMER_SATISFACTION_SCORE | The customer satisfaction score | |
| customerStatus | CUSTOMER_STATUS | The status of the customer in Global Data System | |
| last12MonthsNewRevenueAmount | LAST12_MONTHS_NEW_REVENUE_AMOUNT | The last 12 months new revenue amount of the customer | |
| last12MonthsSupportCallCount | LAST12_MONTHS_SUPPORT_CALL_COUNT | The last 12 months support call count made by the customer | |
| last24MonthsNewRevenueAmount | LAST24_MONTHS_NEW_REVENUE_AMOUNT | The last 24 months new revenue amount of the customer | |
| marketingEmailResponseRate | MARKETING_EMAIL_RESPONSE_RATE | Marketing email response rate of the customer | |
| netPromoterScore | NET_PROMOTER_SCORE | The net promoter score of the customer | |
| originatingCustomerSource | ORIGINATING_CUSTOMER_SOURCE | The originating source of the customer | |
| party[0] | The individual information as party | ||
| id | if(vars.individualRecord != null) (vars.individualRecord) else PARTY_ID | The id of the individual | |
| partyType | PARTY_TYPE | The party type | |
| personName | PERSON_NAME | The person name of the individual | |
| contactPoints [0] | |||
| contactPointType | ['ContactPointEmail'] | The contactpoint type Email | |
| id | EMAIL_ID | The id of the contactpoint stored in Global Data System | |
| activeFromDate | EMAIL_ACTIVE_FROM_DATE | The date from which the email address is active | |
| emailAddress | EMAIL_ADDRESSThe emailaddress of the individual stored in Global Data System | ||
| contactPoints [1] | |||
| contactPointType | ['ContactPointPhone'] | The contactpoint type Phone | |
| id | PHONE_ID | The id of the contactpoint stored in Global Data System | |
| activeFromDate | PHONE_ACTIVE_FROM_DATE | The date from which the Phone is active | |
| formattedNationalPhoneNumber | FORMATTED_NATIONAL_PHONE_NUMBER | The formatted national phone number of the individual stored in Global Data System | |
| telephoneNumber | TELEPHONE_NUMBERThe telephone number of the individual stored in Global Data System | ||
| partyRoleType | PARTY_ROLE_TYPE | The type of party role - default as Customer | |
| prospectRating | PROSPECT_RATING | The prospect rating of the customer | |
| totalBookingsAmount | TOTAL_BOOKINGS_AMOUNT | The total bookings amount made by the customer | |
| totalContractedAmount | TOTAL_CONTRACTED_AMOUNT | The total contracted amount | |
| totalLifeTimeValue | TOTAL_LIFE_TIME_VALUE | The total lifetime value of the customer | |
| totalProfitContributionAmount | TOTAL_PROFIT_CONTRIBUTION_AMOUNT | The total profit contribution amount by the customer | |
| (externalIds | vars.customerExternalIds) if (vars.customerExternalIds !=null and !(isEmpty(vars.customerExternalIds))) | The external Ids of the customer that are stored in Global Data System | |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity | |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created | |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity | |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated | |
| auditInfo.isDeleted | isDeleted default false | Indicates whether or not the entity has been soft-deleted - default as false |
post-externalids-payload
ExternalIds Upsert Mapping for Global Data System
Source:
./src/main/resources/dwl/post-externalids-payload.dwl
Mapping Tables
Maps CIM to Json which is used by stored procedure - sp_Individual_ExternalIds_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| id | id | The id of the entry in Global Data System |
| externalId | externalId | A unique identifier assigned to the individual in another system |
| createdBy | application name from properties | Identifies the system or user which created the entry |
| updatedBy | application name from properties | Identifies the system or user which last updated the entry |
| externalIdType | externalIdType | Identifies the system that owns or otherwise recognises this unique identifier |
| status | status | Indicates whether this identifier is currently valid or not |
| statusLastChangedDate | statusLastChangedDate | Date and time of the last change in status |
get-externalids-response
ExternalIds Query Mapping for Global Data System
Source:
./src/main/resources/dwl/get-externalids-response.dwl
Variables
var outputPayload
outputPayload variable is the maps the result of select query on Global Data EXTERNAL_ID table.
partyroles-get-response
PartyRoles Retrieve Mapping for Global Data System
Source:
./src/main/resources/dwl/partyroles-get-response.dwl
Mapping Tables
Maps Global Data PartyRole to CIM PartyRole format
| CIM - partyRole | Global Data - PARTY_ROLE | Description |
|---|---|---|
| id | ID | The id of the customer in Global Data System |
| partyRoleType | PARTY_ROLE_TYPE | The party role type stored in Global Data System |
| party.id | PARTY_ID | The party identifier stored in Global Data System |
| partyType | PARTY_TYPE | The party type stores in Global Data System |
| globalParty | GLOBAL_PARTY | The global party stored in Global Data System |
| noMergeReason | NO_MERGE_REASON | The reason for no merge |
get-related-parties-response
RelatedParties Retrieve Mapping for Global Data System
Source:
./src/main/resources/dwl/get-related-parties-response.dwl
Functions
fun formatDate (dateformats)
Maps Global Data DB to CIM Json which is used by other process API's
| CIM | Global Data DB | Description |
|---|---|---|
| id | ID | The id of the entry in Global Data System |
| relatedFromDate | RELATED_FROM_DATE | Related From Date with the Party |
| relatedToDate | RELATED_TO_DATE | Related To Date with the Party |
| relatedParty | PARTY_RELATED_PARTY_ID | Indicates the Party that its related to |
| partyRelationshipType | PARTY_RELATION_TYPE.NAME | Pre-defined relation ship between parties |
put-related-parties-payload
RelatedParties Upsert Mapping for Global Data System
Source:
./src/main/resources/dwl/put-related-parties-payload.dwl
Mapping Tables
Maps CIM to Json which is used by stored procedure - Parties_RelatedParties_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| id | id | The id of the entry in Global Data System |
| createdBy | application name from properties | Identifies the system or user which created the entry |
| updatedBy | application name from properties | Identifies the system or user which last updated the entry |
| relatedFromDate | relatedFromDate | Related From Date with the Party |
| relatedToDate | relatedToDate | Related To Date with the Party |
| relatedParty | relatedParty | Indicates the Party that its related to |
| partyRelationshipType | partyRelationshipType | Pre-defined relation ship between parties |
parties-get-response
Parties Query Mapping for Global Data System
Source:
./src/main/resources/dwl/parties-get-response.dwl
Mapping Tables
Maps Global Data PartyRole to CIM PartyRole format
| CIM - partyRole | Global Data - PARTY_ROLE | Description |
|---|---|---|
| id | ID | The party identifier stored in Global Data |
| partyType | PARTY_TYPE | The party type stored in Global Data System |
| globalParty | GLOBAL_PARTY | The global party stored in Global Data System |
| noMergeReason | NO_MERGE_REASON | The reason for no merge |
parties-related-parties-externalids
ExternalIds Query Mapping for Global Data System
Source:
./src/main/resources/dwl/parties-related-parties-externalids.dwl
individuals-post-payload
Create Individual Mapping for Global Data System. Maps CIM Individual to JSON which
is used by stored procedure sp_Individuals_Create.
The fields in both CIM and JSON are identical.
Source:
./src/main/resources/dwl/individuals-post-payload.dwl
Mapping Tables
Maps CIM Individual to Global Data Individual as in DB
| CIM | Global Data DB | Description |
|---|---|---|
| birthDate | BIRTH_DATE | Birth date of the individual |
| birthPlace | BIRTH_PLACE | Birth place of the individual |
| childrenCount | CHILDREN_COUNT | No. of children for the individual |
| consumerCreditScore | CONSUMER_CREDIT_SCORE | Consumer credit score of the individual |
| consumerCreditScoreProviderName | CONSUMER_CREDIT_SCORE_PROVIDER_NAME | Consumer credit score Provider related to the individual |
| convictionsCount | CONVICTIONS_COUNT | Count of convictions related to the individual |
| createdBy | CREATED_BY | Identifies the system or user which created the individual - default as property app.name |
| createdOn | CREATED_ON | Identifies the date on which the individual was created - default as sysdate |
| currentEmployerName | CURRENT_EMPLOYER_NAME | Current employer name of the individual |
| deathDate | DEATH_DATE | Death date of the individual (if applicable) |
| deathPlace | DEATH_PLACE | Death place of the individual |
| dependentCount | DEPENDENT_COUNT | No. of dependents related to the individual |
| doExtractMyDataUpdateDate | DO_EXTRACT_MY_DATA_UPDATE_DATE | Update date to extract data related to the individual |
| doForgetMeFromUpdateDate | DO_FORGET_ME_FROM_UPDATE_DATE | Update date to forget the individual |
| doNotMarketFromUpdateDate | DO_NOT_MARKET_FROM_UPDATE_DATE | Update date to market the individual |
| doNotProcessFromUpdateDate | DO_NOT_PROCESS_FROM_UPDATE_DATE | Update date to not process the individual |
| doNotProcessReason | DO_NOT_PROCESS_REASON | Reason to not process the individual |
| doNotProfileFromUpdateDate | DO_NOT_PROFILE_FROM_UPDATE_DATE | Update date to not profile the individual |
| doNotTrackLocationUpdateDate | DO_NOT_TRACK_LOCATION_UPDATE_DATE | Update date to not track the location of the individual |
| doNotTrackUpdateDate | DO_NOT_TRACK_UPDATE_DATE | Update date to not track the individual |
| employedSinceDate | EMPLOYED_SINCE_DATE | Employed since date of the individual |
| ethnicity | ETHNICITY | Ethnicity of the individual |
| firstName | FIRST_NAME | First name of the individual |
| gender | GENDER | Gender of the individual |
| globalParty | GLOBAL_PARTY | Global Party of the the individual |
| hasAlcoholAbuseHistory | HAS_ALCOHOL_ABUSE_HISTORY | Flag to mark alcohol abuse history |
| hasDrugAbuseHistory | HAS_DRUG_ABUSE_HISTORY | Flag to mark drug abuse history |
| highestEducationLevel | HIGHEST_EDUCATION_LEVEL | Highest education level of the individual |
| hospitalizationsLast5YearsCount | HOSPITALIZATIONS_LAST5_YEARS_COUNT | No. of hospitalization in last 5 years |
| id | ID | Unique Id to identify the individual |
| influencerRating | INFLUENCER_RATING | Influence rating of the individual |
| isAlcoholConsumer | IS_ALCOHOL_CONSUMER | Flag to mark as alcohol consumer |
| isDrugConsumer | IS_DRUG_CONSUMER | Flag to mark as drug consumer |
| isGoodDriver | IS_GOOD_DRIVER | Flag to mark as a good driver |
| isGoodStudent | IS_GOOD_STUDENT | Flag to mark as a good student |
| isHighRiskHobby | IS_HIGH_RISK_HOBBY | Flag to highlight individual has high risk hobby |
| isHighRiskOccupation | IS_HIGH_RISK_OCCUPATION | Flag to highlight individual has high risk occupation |
| isHomeOwner | IS_HOME_OWNER | Flag to mark as a home owner |
| isTobaccoConsume | IS_TOBACCO_CONSUME | Flag to mark individual consumes tobacco |
| lastName | LAST_NAME | Last name of the individual |
| mailingName | MAILING_NAME | Mailing name of the individual |
| mainDietaryHabitType | MAIN_DIETARY_HABIT_TYPE | Main dietary habit type of the individual |
| mainDisabilityType | MAIN_DISABILITY_TYPE | Main disability habit type of the individual |
| mainLifeAttitudeType | MAIN_LIFE_ATTITUDE_TYPE | Main life attitude type of the individual |
| mainLifeStyleType | MAIN_LIFE_STYLE_TYPE | Main life style type of the individual |
| mainPersonalityType | MAIN_PERSONAL_VALUE_TYPE | Main personality type of the individual |
| mainPersonalValueType | MAIN_PERSONALITY_TYPE | Main personal value type of the individual |
| majorCitationCount | MAJOR_CITATION_COUNT | No. of citations related to the individual |
| maritalStatus | MARITAL_STATUS | Marital status of the individual |
| middleName | MIDDLE_NAME | Middle name of the individual |
| militaryService | MILITARY_SERVICE | Military service of the individual |
| militaryStatus | MILITARY_STATUS | Military status of the individual |
| minorCitationCount | MINOR_CITATION_COUNT | No. of minor citations related to the individual |
| mothersMaidenName | MOTHERS_MAIDEN_NAME | Mothers maiden name of the individual |
| nameSuffix | NAME_SUFFIX | Name suffix of the individual |
| netWorth | NET_WORTH | Networth of the individual |
| noMergeReason | NO_MERGE_REASON | Reason to not merge the individual |
| occupation | OCCUPATION | Occupation of the individual |
| occupationType | OCCUPATION_TYPE | Occupation type of the individual |
| officialName | OFFICIAL_NAME | Official name of the individual |
| orderingName | ORDERING_NAME | Ordering name of the individual |
| overAgeNumber | OVER_AGE_NUMBER | Overage number of the individual |
| partyType | PARTY_TYPE | Party type of the individual |
| personHeight | PERSON_HEIGHT | Person height of the individual |
| personHeightUnitOfMeasure | PERSON_HEIGHT_UNIT_OF_MEASURE | Unit of measure used to measure person height of the individual |
| personLifeStage | PERSON_LIFE_STAGE | Person life stage of the individual |
| personName | PERSON_NAME | Person name of the individual |
| personWeight | PERSON_WEIGHT | Person weight of the individual |
| personWeightUnitOfMeasure | PERSON_WEIGHT_UNIT_OF_MEASURE | Unit of measure used to measure person weight of the individual |
| photoURL | PHOTO_URL | URL to the photo of the individual |
| preferredName | PREFERRED_NAME | Preferred name of the individual |
| primaryHobby | PRIMARY_HOBBY | Primary hobby of the individual |
| religion | RELIGION | Religion of the individual |
| residenceCaptureMethod | RESIDENCE_CAPTURE_METHOD | Residence capture method of the individual |
| residenceCountryName | RESIDENCE_COUNTRY_NAME | Country of residence of the individual |
| salutation | SALUTATION | Salutation of the individual |
| secondLastName | SECOND_LAST_NAME | Second last name of the individual |
| sendIndividualData | SEND_INDIVIDUAL_DATA | Flag to mark if individual data can be sent related to the individual |
| shouldForget | SHOULD_FORGET | Flag to forget the individual |
| surgeriesLast5YearsCount | SURGERIES_LAST5_YEARS_COUNT | No. of surgeries in last 5 years related to the individual |
| taxBracketRange | TAX_BRACKET_RANGE | Tax bracket range of the individual |
| updatedBy | UPDATED_BY | Identifies the system or user which updated the individual - default as property app.name |
| updatedOn | UPDATED_ON | Identifies the date on which the individual was updated - default as sysdate |
| webSiteURL | WEB_SITE_URL | URL of the website related to the individual |
| weddingAnniversaryDate | WEDDING_ANNIVERSARY_DATE | Wedding anniversary date of the individual |
| yearlyIncome | YEARLY_INCOME | Yearly income of the individual |
| yearlyIncomeRange | YEARLY_INCOME_RANGE | Yearly income range of the individual |
individuals-patch-payload
Update Individual Mapping for Global Data System. Maps CIM Indiviudal to payload
which is used as input parameter in the update query of INDIVIDUAL table.
The fields in both CIM and Global Data are identical.
PATCH payload is created by validating the Input Request payload with DB Record Payload.
Few of the DB fields will not be updated as they are not allowed.
Source:
./src/main/resources/dwl/individuals-patch-payload.dwl
Variables
var payloadRecordfromDB
payloadRecordfromDB is the existing customer record in Global Data System
Mapping Tables
Maps CIM Individual to Global Data Individual as in DB
| CIM | Global Data DB | Description |
|---|---|---|
| birthDate | BIRTH_DATE | Birth date of the individual |
| birthPlace | BIRTH_PLACE | Birth place of the individual |
| childrenCount | CHILDREN_COUNT | No. of children for the individual |
| consumerCreditScore | CONSUMER_CREDIT_SCORE | Consumer credit score of the individual |
| consumerCreditScoreProviderName | CONSUMER_CREDIT_SCORE_PROVIDER_NAME | Consumer credit score Provider related to the individual |
| convictionsCount | CONVICTIONS_COUNT | Count of convictions related to the individual |
| createdBy | CREATED_BY | Identifies the system or user which created the individual - default as property app.name |
| createdOn | CREATED_ON | Identifies the date on which the individual was created - default as sysdate |
| currentEmployerName | CURRENT_EMPLOYER_NAME | Current employer name of the individual |
| deathDate | DEATH_DATE | Death date of the individual (if applicable) |
| deathPlace | DEATH_PLACE | Death place of the individual |
| dependentCount | DEPENDENT_COUNT | No. of dependents related to the individual |
| doExtractMyDataUpdateDate | DO_EXTRACT_MY_DATA_UPDATE_DATE | Update date to extract data related to the individual |
| doForgetMeFromUpdateDate | DO_FORGET_ME_FROM_UPDATE_DATE | Update date to forget the individual |
| doNotMarketFromUpdateDate | DO_NOT_MARKET_FROM_UPDATE_DATE | Update date to market the individual |
| doNotProcessFromUpdateDate | DO_NOT_PROCESS_FROM_UPDATE_DATE | Update date to not process the individual |
| doNotProcessReason | DO_NOT_PROCESS_REASON | Reason to not process the individual |
| doNotProfileFromUpdateDate | DO_NOT_PROFILE_FROM_UPDATE_DATE | Update date to not profile the individual |
| doNotTrackLocationUpdateDate | DO_NOT_TRACK_LOCATION_UPDATE_DATE | Update date to not track the location of the individual |
| doNotTrackUpdateDate | DO_NOT_TRACK_UPDATE_DATE | Update date to not track the individual |
| employedSinceDate | EMPLOYED_SINCE_DATE | Employed since date of the individual |
| ethnicity | ETHNICITY | Ethnicity of the individual |
| firstName | FIRST_NAME | First name of the individual |
| gender | GENDER | Gender of the individual |
| globalParty | GLOBAL_PARTY | Global Party of the the individual |
| hasAlcoholAbuseHistory | HAS_ALCOHOL_ABUSE_HISTORY | Flag to mark alcohol abuse history |
| hasDrugAbuseHistory | HAS_DRUG_ABUSE_HISTORY | Flag to mark drug abuse history |
| highestEducationLevel | HIGHEST_EDUCATION_LEVEL | Highest education level of the individual |
| hospitalizationsLast5YearsCount | HOSPITALIZATIONS_LAST5_YEARS_COUNT | No. of hospitalization in last 5 years |
| id | ID | Unique Id to identify the individual |
| influencerRating | INFLUENCER_RATING | Influence rating of the individual |
| isAlcoholConsumer | IS_ALCOHOL_CONSUMER | Flag to mark as alcohol consumer |
| isDrugConsumer | IS_DRUG_CONSUMER | Flag to mark as drug consumer |
| isGoodDriver | IS_GOOD_DRIVER | Flag to mark as a good driver |
| isGoodStudent | IS_GOOD_STUDENT | Flag to mark as a good student |
| isHighRiskHobby | IS_HIGH_RISK_HOBBY | Flag to highlight individual has high risk hobby |
| isHighRiskOccupation | IS_HIGH_RISK_OCCUPATION | Flag to highlight individual has high risk occupation |
| isHomeOwner | IS_HOME_OWNER | Flag to mark as a home owner |
| isTobaccoConsume | IS_TOBACCO_CONSUME | Flag to mark individual consumes tobacco |
| lastName | LAST_NAME | Last name of the individual |
| mailingName | MAILING_NAME | Mailing name of the individual |
| mainDietaryHabitType | MAIN_DIETARY_HABIT_TYPE | Main dietary habit type of the individual |
| mainDisabilityType | MAIN_DISABILITY_TYPE | Main disability habit type of the individual |
| mainLifeAttitudeType | MAIN_LIFE_ATTITUDE_TYPE | Main life attitude type of the individual |
| mainLifeStyleType | MAIN_LIFE_STYLE_TYPE | Main life style type of the individual |
| mainPersonalityType | MAIN_PERSONAL_VALUE_TYPE | Main personality type of the individual |
| mainPersonalValueType | MAIN_PERSONALITY_TYPE | Main personal value type of the individual |
| majorCitationCount | MAJOR_CITATION_COUNT | No. of citations related to the individual |
| maritalStatus | MARITAL_STATUS | Marital status of the individual |
| middleName | MIDDLE_NAME | Middle name of the individual |
| militaryService | MILITARY_SERVICE | Military service of the individual |
| militaryStatus | MILITARY_STATUS | Military status of the individual |
| minorCitationCount | MINOR_CITATION_COUNT | No. of minor citations related to the individual |
| mothersMaidenName | MOTHERS_MAIDEN_NAME | Mothers maiden name of the individual |
| nameSuffix | NAME_SUFFIX | Name suffix of the individual |
| netWorth | NET_WORTH | Networth of the individual |
| noMergeReason | NO_MERGE_REASON | Reason to not merge the individual |
| occupation | OCCUPATION | Occupation of the individual |
| occupationType | OCCUPATION_TYPE | Occupation type of the individual |
| officialName | OFFICIAL_NAME | Official name of the individual |
| orderingName | ORDERING_NAME | Ordering name of the individual |
| overAgeNumber | OVER_AGE_NUMBER | Overage number of the individual |
| partyType | PARTY_TYPE | Party type of the individual |
| personHeight | PERSON_HEIGHT | Person height of the individual |
| personHeightUnitOfMeasure | PERSON_HEIGHT_UNIT_OF_MEASURE | Unit of measure used to measure person height of the individual |
| personLifeStage | PERSON_LIFE_STAGE | Person life stage of the individual |
| personName | PERSON_NAME | Person name of the individual |
| personWeight | PERSON_WEIGHT | Person weight of the individual |
| personWeightUnitOfMeasure | PERSON_WEIGHT_UNIT_OF_MEASURE | Unit of measure used to measure person weight of the individual |
| photoURL | PHOTO_URL | URL to the photo of the individual |
| preferredName | PREFERRED_NAME | Preferred name of the individual |
| primaryHobby | PRIMARY_HOBBY | Primary hobby of the individual |
| religion | RELIGION | Religion of the individual |
| residenceCaptureMethod | RESIDENCE_CAPTURE_METHOD | Residence capture method of the individual |
| residenceCountryName | RESIDENCE_COUNTRY_NAME | Country of residence of the individual |
| salutation | SALUTATION | Salutation of the individual |
| secondLastName | SECOND_LAST_NAME | Second last name of the individual |
| sendIndividualData | SEND_INDIVIDUAL_DATA | Flag to mark if individual data can be sent related to the individual |
| shouldForget | SHOULD_FORGET | Flag to forget the individual |
| surgeriesLast5YearsCount | SURGERIES_LAST5_YEARS_COUNT | No. of surgeries in last 5 years related to the individual |
| taxBracketRange | TAX_BRACKET_RANGE | Tax bracket range of the individual |
| updatedBy | UPDATED_BY | Identifies the system or user which updated the individual - default as property app.name |
| updatedOn | UPDATED_ON | Identifies the date on which the individual was updated - default as sysdate |
| webSiteURL | WEB_SITE_URL | URL of the website related to the individual |
| weddingAnniversaryDate | WEDDING_ANNIVERSARY_DATE | Wedding anniversary date of the individual |
| yearlyIncome | YEARLY_INCOME | Yearly income of the individual |
| yearlyIncomeRange | YEARLY_INCOME_RANGE | Yearly income range of the individual |
individuals-get-response
Search and Retrieve of Individual Mappings for Global Data System
Source:
./src/main/resources/dwl/individuals-get-response.dwl
Mapping Tables
Maps Global Data Individual as in DB to CIM Individual
| CIM | Global Data DB | Description |
|---|---|---|
| birthDate | BIRTH_DATE | Birth date of the individual |
| birthPlace | BIRTH_PLACE | Birth place of the individual |
| childrenCount | CHILDREN_COUNT | No. of children for the individual |
| consumerCreditScore | CONSUMER_CREDIT_SCORE | Consumer credit score of the individual |
| consumerCreditScoreProviderName | CONSUMER_CREDIT_SCORE_PROVIDER_NAME | Consumer credit score Provider related to the individual |
| convictionsCount | CONVICTIONS_COUNT | Count of convictions related to the individual |
| createdBy | CREATED_BY | Identifies the system or user which created the individual - default as property app.name |
| createdOn | CREATED_ON | Identifies the date on which the individual was created - default as sysdate |
| currentEmployerName | CURRENT_EMPLOYER_NAME | Current employer name of the individual |
| deathDate | DEATH_DATE | Death date of the individual (if applicable) |
| deathPlace | DEATH_PLACE | Death place of the individual |
| dependentCount | DEPENDENT_COUNT | No. of dependents related to the individual |
| doExtractMyDataUpdateDate | DO_EXTRACT_MY_DATA_UPDATE_DATE | Update date to extract data related to the individual |
| doForgetMeFromUpdateDate | DO_FORGET_ME_FROM_UPDATE_DATE | Update date to forget the individual |
| doNotMarketFromUpdateDate | DO_NOT_MARKET_FROM_UPDATE_DATE | Update date to market the individual |
| doNotProcessFromUpdateDate | DO_NOT_PROCESS_FROM_UPDATE_DATE | Update date to not process the individual |
| doNotProcessReason | DO_NOT_PROCESS_REASON | Reason to not process the individual |
| doNotProfileFromUpdateDate | DO_NOT_PROFILE_FROM_UPDATE_DATE | Update date to not profile the individual |
| doNotTrackLocationUpdateDate | DO_NOT_TRACK_LOCATION_UPDATE_DATE | Update date to not track the location of the individual |
| doNotTrackUpdateDate | DO_NOT_TRACK_UPDATE_DATE | Update date to not track the individual |
| employedSinceDate | EMPLOYED_SINCE_DATE | Employed since date of the individual |
| ethnicity | ETHNICITY | Ethnicity of the individual |
| firstName | FIRST_NAME | First name of the individual |
| gender | GENDER | Gender of the individual |
| globalParty | GLOBAL_PARTY | Global Party of the the individual |
| hasAlcoholAbuseHistory | HAS_ALCOHOL_ABUSE_HISTORY | Flag to mark alcohol abuse history |
| hasDrugAbuseHistory | HAS_DRUG_ABUSE_HISTORY | Flag to mark drug abuse history |
| highestEducationLevel | HIGHEST_EDUCATION_LEVEL | Highest education level of the individual |
| hospitalizationsLast5YearsCount | HOSPITALIZATIONS_LAST5_YEARS_COUNT | No. of hospitalization in last 5 years |
| id | ID | Unique Id to identify the individual |
| influencerRating | INFLUENCER_RATING | Influence rating of the individual |
| isAlcoholConsumer | IS_ALCOHOL_CONSUMER | Flag to mark as alcohol consumer |
| isDrugConsumer | IS_DRUG_CONSUMER | Flag to mark as drug consumer |
| isGoodDriver | IS_GOOD_DRIVER | Flag to mark as a good driver |
| isGoodStudent | IS_GOOD_STUDENT | Flag to mark as a good student |
| isHighRiskHobby | IS_HIGH_RISK_HOBBY | Flag to highlight individual has high risk hobby |
| isHighRiskOccupation | IS_HIGH_RISK_OCCUPATION | Flag to highlight individual has high risk occupation |
| isHomeOwner | IS_HOME_OWNER | Flag to mark as a home owner |
| isTobaccoConsume | IS_TOBACCO_CONSUME | Flag to mark individual consumes tobacco |
| lastName | LAST_NAME | Last name of the individual |
| mailingName | MAILING_NAME | Mailing name of the individual |
| mainDietaryHabitType | MAIN_DIETARY_HABIT_TYPE | Main dietary habit type of the individual |
| mainDisabilityType | MAIN_DISABILITY_TYPE | Main disability habit type of the individual |
| mainLifeAttitudeType | MAIN_LIFE_ATTITUDE_TYPE | Main life attitude type of the individual |
| mainLifeStyleType | MAIN_LIFE_STYLE_TYPE | Main life style type of the individual |
| mainPersonalityType | MAIN_PERSONAL_VALUE_TYPE | Main personality type of the individual |
| mainPersonalValueType | MAIN_PERSONALITY_TYPE | Main personal value type of the individual |
| majorCitationCount | MAJOR_CITATION_COUNT | No. of citations related to the individual |
| maritalStatus | MARITAL_STATUS | Marital status of the individual |
| middleName | MIDDLE_NAME | Middle name of the individual |
| militaryService | MILITARY_SERVICE | Military service of the individual |
| militaryStatus | MILITARY_STATUS | Military status of the individual |
| minorCitationCount | MINOR_CITATION_COUNT | No. of minor citations related to the individual |
| mothersMaidenName | MOTHERS_MAIDEN_NAME | Mothers maiden name of the individual |
| nameSuffix | NAME_SUFFIX | Name suffix of the individual |
| netWorth | NET_WORTH | Networth of the individual |
| noMergeReason | NO_MERGE_REASON | Reason to not merge the individual |
| occupation | OCCUPATION | Occupation of the individual |
| occupationType | OCCUPATION_TYPE | Occupation type of the individual |
| officialName | OFFICIAL_NAME | Official name of the individual |
| orderingName | ORDERING_NAME | Ordering name of the individual |
| overAgeNumber | OVER_AGE_NUMBER | Overage number of the individual |
| partyType | PARTY_TYPE | Party type of the individual |
| personHeight | PERSON_HEIGHT | Person height of the individual |
| personHeightUnitOfMeasure | PERSON_HEIGHT_UNIT_OF_MEASURE | Unit of measure used to measure person height of the individual |
| personLifeStage | PERSON_LIFE_STAGE | Person life stage of the individual |
| personName | PERSON_NAME | Person name of the individual |
| personWeight | PERSON_WEIGHT | Person weight of the individual |
| personWeightUnitOfMeasure | PERSON_WEIGHT_UNIT_OF_MEASURE | Unit of measure used to measure person weight of the individual |
| photoURL | PHOTO_URL | URL to the photo of the individual |
| preferredName | PREFERRED_NAME | Preferred name of the individual |
| primaryHobby | PRIMARY_HOBBY | Primary hobby of the individual |
| religion | RELIGION | Religion of the individual |
| residenceCaptureMethod | RESIDENCE_CAPTURE_METHOD | Residence capture method of the individual |
| residenceCountryName | RESIDENCE_COUNTRY_NAME | Country of residence of the individual |
| salutation | SALUTATION | Salutation of the individual |
| secondLastName | SECOND_LAST_NAME | Second last name of the individual |
| sendIndividualData | SEND_INDIVIDUAL_DATA | Flag to mark if individual data can be sent related to the individual |
| shouldForget | SHOULD_FORGET | Flag to forget the individual |
| surgeriesLast5YearsCount | SURGERIES_LAST5_YEARS_COUNT | No. of surgeries in last 5 years related to the individual |
| taxBracketRange | TAX_BRACKET_RANGE | Tax bracket range of the individual |
| updatedBy | UPDATED_BY | Identifies the system or user which updated the individual - default as property app.name |
| updatedOn | UPDATED_ON | Identifies the date on which the individual was updated - default as sysdate |
| webSiteURL | WEB_SITE_URL | URL of the website related to the individual |
| weddingAnniversaryDate | WEDDING_ANNIVERSARY_DATE | Wedding anniversary date of the individual |
| yearlyIncome | YEARLY_INCOME | Yearly income of the individual |
| yearlyIncomeRange | YEARLY_INCOME_RANGE | Yearly income range of the individual |
organizations-post-payload
Create organization Mapping for Global Data System.
Maps CIM organization to JSON which is used by stored procedure sp_Organizations_Create.
The fields in both CIM and JSON are identical.
Source:
./src/main/resources/dwl/organizations-post-payload.dwl
Mapping Tables
Maps CIM Organization to Global Data Organization as in DB
| CIM | Global Data DB | Description |
|---|---|---|
| name | NAME | Name of the organization |
| createdBy | CREATED_BY | Identifies the system or user which created the organization - default as property app.name |
| createdOn | CREATED_ON | Identifies the date on which the organization was created - default as sysdate |
| globalParty | GLOBAL_PARTY | Global Party of the the organization |
| id | ID | Unique Id to identify the organization |
| legalName | LEGAL_NAME | Legal name of the organization |
| noMergeReason | NO_MERGE_REASON | Reason to not merge the organization |
| partyType | PARTY_TYPE | Party type of the organization |
| updatedBy | UPDATED_BY | Identifies the system or user which updated the organization - default as property app.name |
| updatedOn | UPDATED_ON | Identifies the date on which the organization was updated - default as sysdate |
organizations-patch-payload
Create Organization Mapping for Global Data System
Maps CIM Organization to payload which is used as input parameter in the update query of ORGANIZATION table.
The fields in both CIM and Global Data System are identical.
PATCH payload is created by validating the Input Request payload with DB Record Payload.
Source:
./src/main/resources/dwl/organizations-patch-payload.dwl
Variables
var payloadRecordfromDB
payloadRecordfromDB is the existing customer record in Global Data System
Mapping Tables
Maps CIM Organization to Global Data Organization as in DB
| CIM | Global Data DB | Description |
|---|---|---|
| name | NAME | Name of the organization |
| createdBy | CREATED_BY | Identifies the system or user which created the organization - default as property app.name |
| createdOn | CREATED_ON | Identifies the date on which the organization was created - default as sysdate |
| globalParty | GLOBAL_PARTY | Global Party of the the organization |
| id | ID | Unique Id to identify the organization |
| legalName | LEGAL_NAME | Legal name of the organization |
| noMergeReason | NO_MERGE_REASON | Reason to not merge the organization |
| partyType | PARTY_TYPE | Party type of the organization |
| updatedBy | UPDATED_BY | Identifies the system or user which updated the organization - default as property app.name |
| updatedOn | UPDATED_ON | Identifies the date on which the organization was updated - default as sysdate |
organizations-get-response
Retrieve Organization Mapping for Global Data System
Source:
./src/main/resources/dwl/organizations-get-response.dwl
Mapping Tables
Maps CIM Organization to Global Data Organization as in DB
| CIM | Global Data DB | Description |
|---|---|---|
| name | NAME | Name of the organization |
| createdBy | CREATED_BY | Identifies the system or user which created the organization - default as property app.name |
| createdOn | CREATED_ON | Identifies the date on which the organization was created - default as sysdate |
| globalParty | GLOBAL_PARTY | Global Party of the the organization |
| id | ID | Unique Id to identify the organization |
| legalName | LEGAL_NAME | Legal name of the organization |
| noMergeReason | NO_MERGE_REASON | Reason to not merge the organization |
| partyType | PARTY_TYPE | Party type of the organization |
| updatedBy | UPDATED_BY | Identifies the system or user which updated the organization - default as property app.name |
| updatedOn | UPDATED_ON | Identifies the date on which the organization was updated - default as sysdate |
households-post-payload
Create Household Mapping for Global Data System. Maps CIM Household to payload which
is used as input parameter to insert into Household table. The fields in both
CIM and Global Data are identical.
Source:
./src/main/resources/dwl/households-post-payload.dwl
Mapping Tables
Maps CIM Household to JSON which is used by stored procedure - sp_Households_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| householdDissolvedDate | householdDissolvedDate | DissolvedDate of HouseHold |
| householdFormedDate | householdFormedDate | Household Formed Date |
| householdMemberCount | householdMemberCount | Count of people in a Household |
| globalParty | globalParty | Global Party Id for Household |
| id | id | The id of the customer |
| name | name | A name given for a Household |
| partyType | "Household" | The type of party - default as Household |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
households-patch-payload
Mapping for Global Data System to Update Household. Maps CIM Household to payload
which is used as input parameter in the update Household table. The fields in
both CIM and Global Data are identical. PATCH payload is created by validating the
Input Request payload with DB Record Payload.
Source:
./src/main/resources/dwl/households-patch-payload.dwl
Variables
var payloadRecordfromDB
payloadRecordfromDB is the existing customer record in Global Data System
Mapping Tables
Maps CIM Household to JSON which is used by stored procedure - sp_Households_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| householdDissolvedDate | householdDissolvedDate | DissolvedDate of HouseHold |
| householdFormedDate | householdFormedDate | Household Formed Date |
| householdMemberCount | householdMemberCount | Count of people in a Household |
| globalParty | globalParty | Global Party Id for Household |
| id | id | The id of the customer |
| name | name | A name given for a Household |
| partyType | "Household" | The type of party - default as Household |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
households-get-response
Retrieve and Search Household Mapping for Global Data System
Source:
./src/main/resources/dwl/households-get-response.dwl
Mapping Tables
Maps Database table Household to CIM JSON
| CIM | Global Data DB | Description |
|---|---|---|
| householdDissolvedDate | HOUSEHOLD_DISSOLVED_DATE | DissolvedDate of HouseHold |
| householdFormedDate | HOUSEHOLD_FORMED_DATE | Household Formed Date |
| householdMemberCount | HOUSEHOLD_MEMBER_COUNT | Count of people in a Household |
| globalParty | GLOBAL_PARTY | Global Party Id for Household |
| id | id | The id of the customer |
| name | name | A name given for a Household |
| partyType | PARTY_TYPE | The type of party - default as Household |
| (externalIds | vars.customerExternalIds) if (vars.customerExternalIds !=null and !(isEmpty(vars.customerExternalIds))) | The external Ids of the customer that are stored in Core Banking System |
| auditInfo.createdDate | CREATED_DATE | Identifies the system or user which created the entity - default as current timestamp |
| auditInfo.createdBy | CREATED_BY | Timestamp of when the entity was created - default as current timestamp |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity - default as property app.name |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated - default as current timestamp |